﻿// <copyright file="IExplorerControl.cs" company="Soumya Chattopadhyay">
// Copyright (c) 2010 All Right Reserved
// </copyright>
// <disclaimer> This software is intented for educational purposes only and not for 
// commerical or prodution use. The software is provided "as is", without warranty 
// of any kind, express or implied, including but not limited to the warranties of 
// merchantability, fitness for a particular purpose and noninfringement. In no event 
// shall the author(s) or copyright holder(s) be liable for any claim, damages or other 
// liability, whether in an action of contract, tort or otherwise, arising from, out of 
// or in connection with the software or the use or other dealings in the software.
// </disclaimer>

namespace My.CodePlex.TFSExplorer
{
    using System;
    using System.Windows;
    using My.CodePlex.TFSExplorer.TeamFoundation;

    /// <summary>
    /// Dashboard controls need to update the main control of the status
    /// </summary>
    public interface IExplorerControl
    {
        /// <summary>
        /// Gets or sets the tab item header
        /// </summary>
        string Header { get; set; }

        /// <summary>
        /// Gets or sets the child control name
        /// </summary>
        string ControlName { get; set; }

        /// <summary>
        /// Populate the explorer child control
        /// </summary>
        /// <param name="tfs">The TFS context</param>
        void Populate(TeamFoundationContext tfs);
    }
}
